DEVICE SERCOM

The SERCOM device is a tool established in the CPU that allows to transmit and receive data via serial communication ports. The received data are stored in a buffer of adjustable size. Also receiving can be adjusted automatically by the application of the XON-XOFF protocol. To transmit data using fixed memory area formed by 64 byte. Since that receive and send buffers are different, you can create a shortcut both Half-Duplex and Full-Duplex links.
Using the capabilities of the low level of this device you can implement in your QCL code the highest level communication protocol allowing serial communication with different equipment (example: bar-code reader, linear position sensors with serial data transmission, small printer, ecc.).

Declaration of the used device (internal device): device name assigned, SERCOM, sampling time, serial port, size of receive buffer.

;-------------------------------
;Internal device declaration
;-------------------------------
INTDEVICE
...
<device_name>         SERCOM TCamp serial_port dim_buffer_rx
...

Where:

The Declaration of the hardware used in the “BUS” section of the configuration unit you will have to refer to the firmware of the hardware itself.

Example
;-------------------------------
;Internal device declaration
;-------------------------------
INTDEVICE
...
DevSer       SERCOM         0001   0000   0100
...

The receive and transmit buffers are distinguished, you can then make an Half-Duplex and Full-Duplex connections.

The receive buffer is a memory FIFO type (First Input First Output). The device provides a parameter (ibyte1 ), in response to a command (RECEIVED), the first data received. There is also a parameter that contains the number of received data and in the buffer ( nrx ). With this informations it is easy to write a program in QCL which might “empty” the buffer as arriving data.
The buffer is “circular”: once you run out of space destined to receive subsequent data go to overwrite previously received (if you don't use the XON-XOFF). The latter event is reported in the err parameter.
The receive buffer size can be set in the configuration file at the time of the device declaration. It's important to correctly adjust the receive buffer to prevent the data loss. For example, if a instrument normally broadcasts a 100 characters string and the buffer has a capacity to store 50 characters, or stops the transmission of the string or you lose the data. If the transmitter instrument manages the XON-XOFF protocol the device interrupts its transmission by sending the XOFF character, reactivating the XON character when buffer space is freed.

The transmit buffer is fixed-size. It is composed from variables “obyteNN”, with NN from 1 to 64. In the case of the transmission you can write every single byte in transmission. With a single command ( SEND ) you will be able to transfer a message consisting of a ntx number of byte (up to 64 max). If this is not sufficient, it's always possible to transmit multiple consecutive packets to complete the message. The use of a subsequent packets require the receiving system does not time-out may be turned on receiving between a character and the next (see section “Limitations”).

The device uses a software flow control, composed from send/receive of two characters (XOn and XOff) enhance enable or temporarily block the transmission of the external device to the Qmove to allow the processing of data already received and emptying buffer. Flow control can be enabled as an automatic feature to avoid filling the receive buffer.
The threshold of XOn and XOff are respectively set by the parameters: xonlim and xofflim.

Il nome del parametro, stato o comando viene riportato alla sinistra della tabella.

R
Indica se il relativo parametro o stato è ritentivo (al momento dell’inizializzazione del device mantiene lo stato precedentemente definito), oppure lo stato che assume al momento dell’inizializzazione del device.
Se il device non necessita di inizializzazione il campo “R” indica il valore che il parametro o stato assume all’accensione della scheda.
R = Ritentivo
0 = Al momento dell’inizializzazione del device il valore viene forzato a zero.
1 = Al momento dell’inizializzazione del device il valore viene forzato a uno.
- = Al momento dell’inizializzazione del device viene presentato il valore significativo.

D
Indica la dimensione del parametro.
F = Flag
B = Byte
W = Word
L = Long
S = Single Float

Vengono descritte tutte le condizioni necessarie affinché il parametro sia considerato corretto o perché il comando venga accettato.
In alcuni casi vengono specificati dei valori limite per l’accettazione del parametro: se vengono introdotti dei valori esterni ai limiti impostati, il dato viene comunque accettato; pertanto devono essere previsti opportuni controlli dell’applicativo tali da garantire il corretto funzionamento.
Per l’esecuzione di un comando, tutte le relative condizioni devono necessariamente essere soddisfatte; in caso contrario il comando non viene eseguito.

A
Indica la modalità di accesso.
R = Read (lettura).
W = Write (scrittura).
RW = Read / Write.

I comandi a disposizione per gestire il device sono elencati sotto l'ordine di priorità decrescente. Il device esegue tutti i comandi ricevuti entro lo stesso tempo di campionamento iniziando da quello con la priorità maggiore. Per esempio se il device riceve nello stesso tempo di campionamento i comandi CLOSECOM e OPENCOM, per primo esegue il comando OPENCOM e poi quello di CLOSECOM lasciando perciò la porta di comunicazione chiusa.

Di seguito vengono elencate alcune limitazioni sull’utilizzo del device SERCOM:

• Non è possibile utilizzare il device con i sistemi che controllano i time-out tra caratteri, se la lunghezza del messaggio da trasmettere supera la dimensione del buffer di trasmissione; tra l’invio dei primi 64 byte ed i successivi, il QCL dovrà intervenire per riscrivere il buffer di trasmissione.
• La velocità massima è di 57600 baud, la minima è 4800;
• Se il collegamento avviene verso sistemi che utilizzano controlli di flusso diversi da XOn/XOff, è necessario implementare il controllo stesso utilizzando il QCL. Se poi i sistemi utilizzano un controllo di flusso hardware, essi non sono collegabili;
• Se il collegamento avviene verso sistemi in una catena daisy-chain in cui ogni componente esegue l’echo dei caratteri ricevuti, è necessario fare attenzione alle velocità di propagazione dei dati poiché la funzione di echo dovrà essere eseguita utilizzando il QCL.
• Non tutte le combinazioni di valori dei parametri DataBits, StopBits e ParityBit sono abilitate. Se si utilizza una combinazione di valori non abilitata, quando si tenta di aprire la porta seriale mediante il comando OPENCOM il device genera un warning command.

Di seguito uno schema delle combinazioni:

Di seguito si riportano alcuni esempi su come utilizzare il device.
Negli esempi il nome del device sarà DevSer.

Trasmissione di una stringa di controllo in formato ASCII verso uno strumento serie DIN HB237.04A.

La stringa da trasmettere è: {13QL1234561000@

Il codice da scrivere è il seguente:

DevSer:mode = 0
...
address = 13
quota = 123456
...
DevSer:obyte1 = 123               ; carattere {
tmp = address
tmp1 = tmp / 10
DevSer:obyte2 = tmp1 + 48         ; carattere 1
tmp = tmp - (tmp1 * 10)
DevSer:obyte3 = tmp + 48          ; carattere 3
DevSer:obyte4 = 81                ; carattere Q
DevSer:obyte5 = 76                ; carattere L
tmp = quota
tmp1 = tmp / 100000
DevSer:obyte6 = tmp1 + 48         ; carattere 1
tmp = tmp - (tmp1 * 100000)
tmp1 = tmp / 10000
DevSer:obyte7 = tmp1 + 48         ; carattere 2
tmp = tmp - (tmp1 * 10000)
tmp1 = tmp / 1000
DevSer:obyte8 = tmp1 + 48         ; carattere 3
tmp = tmp - (tmp1 * 1000)
tmp1 = tmp / 100
DevSer:obyte9 = tmp1 + 48         ; carattere 4
tmp = tmp - (tmp1 * 100)
tmp1 = tmp / 10
DevSer:obyte10 = tmp1 + 48        ; carattere 5
tmp = tmp - (tmp1 * 10)
DevSer:obyte11 = tmp1 + 48        ; carattere 6
DevSer:obyte12 = 49               ; carattere 1
DevSer:obyte13 = 48               ; carattere 0
DevSer:obyte14 = 48               ; carattere 0
DevSer:obyte15 = 48               ; carattere 0
DevSer:obyte16 = 64               ; carattere @
 
DevSer:ntx = 16                   ; imposta l'invio di 16 caratteri
 
SEND DevSer                       ; Invia la stringa
WAIT DevSer:st_sended             ; e attendi fine trasmissione

Ricezione di una stringa proveniente da uno strumento HB237.04A in formato ASCII e esecuzione dell’eco di ogni carattere ricevuto.

La stringa da ricevere è: [13RS123456123456@

Il codice da scrivere è:

DevSer:mode = 0
sequenza = 0
...
WAIT DevSer:nrx                           ; attendi ricezione carattere
RECEIVED DevSer
DevSer:obyte1 = DevSer:ibyte1             ; esecuzione local echo
DevSer:ntx = 1                            ; imposta l'invio di 1 carattere
SEND DevSer                               ; Invia la stringa
IF sequenza EQ 0
  IF DevSer:ibyte1 EQ 91                  ; verifica carattere [
    indirizzo = 0
    sequenza = 1
  ENDIF
ENDIF
IF sequenza EQ 1
indirizzo = DevSer:ibyte1 * 10
sequenza = 2
ENDIF
IF sequenza EQ 2
  indirizzo = indirizzo + DevSer:ibyte1
  IF indirizzo EQ 13                      ; verifica valore indirizzo
    sequenza = 3
  ELSE
    sequenza = 0
  ENDIF
ENDIF
...
WAIT DevSer:st_sended                     ; attendi fine trasmissione echo